home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 January: Mac OS SDK / Dev.CD Jan 98 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Universal / Interfaces / AIncludes / TextUtils.a < prev    next >
Encoding:
Text File  |  1997-08-12  |  11.8 KB  |  431 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        TextUtils.a
  3. ;
  4. ;    Contains:    Text Utilities Interfaces.
  5. ;
  6. ;    Version:    Technology:    System 7.5
  7. ;                Release:    Universal Interfaces 3.0.1
  8. ;
  9. ;    Copyright:    © 1985-1997 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__TEXTUTILS__') = 'UNDEFINED' THEN
  19. __TEXTUTILS__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__NUMBERFORMATTING__') = 'UNDEFINED' THEN
  25.     include 'NumberFormatting.a'
  26.     ENDIF
  27.     IF &TYPE('__STRINGCOMPARE__') = 'UNDEFINED' THEN
  28.     include 'StringCompare.a'
  29.     ENDIF
  30.     IF &TYPE('__DATETIMEUTILS__') = 'UNDEFINED' THEN
  31.     include 'DateTimeUtils.a'
  32.     ENDIF
  33.  
  34. ; 
  35. ;
  36. ;    Here are the current System 7 routine names and the translations to the older forms.
  37. ;    Please use the newer forms in all new code and migrate the older names out of existing
  38. ;    code as maintainance permits.
  39. ;    
  40. ;    NEW NAME                    OLD NAMEs                    OBSOLETE FORM (no script code)
  41. ;
  42. ;    FindScriptRun
  43. ;    FindWordBreaks                                            NFindWord, FindWord
  44. ;    GetIndString            
  45. ;    GetString
  46. ;    Munger
  47. ;    NewString                
  48. ;    SetString                
  49. ;    StyledLineBreak
  50. ;    TruncString
  51. ;    TruncText
  52. ;
  53. ;    UpperString ($A054)            UprString, UprText
  54. ;    UppercaseText                SCUpperText (a only)        UpperText ($A456)
  55. ;    LowercaseText                                            LwrString, LowerText, LwrText ($A056)
  56. ;    StripDiacritics                                            StripText ($A256)
  57. ;    UppercaseStripDiacritics                                StripUpperText ($A656)
  58. ;
  59. ;
  60. ;
  61.  
  62.  
  63. ;  Type for truncWhere parameter in TruncString, TruncText 
  64. ; typedef short                         TruncCode
  65.  
  66.  
  67.                                                             ; Constants for truncWhere argument in TruncString and TruncText 
  68. truncEnd                        EQU        0                    ; Truncate at end 
  69. truncMiddle                        EQU        $4000                ; Truncate in middle 
  70. smTruncEnd                        EQU        0                    ; Truncate at end - obsolete 
  71. smTruncMiddle                    EQU        $4000                ; Truncate in middle - obsolete 
  72.  
  73.                                                             ; Constants for TruncString and TruncText results 
  74. notTruncated                    EQU        0                    ; No truncation was necessary 
  75. truncated                        EQU        1                    ; Truncation performed 
  76. truncErr                        EQU        -1                    ; General error 
  77. smNotTruncated                    EQU        0                    ; No truncation was necessary - obsolete 
  78. smTruncated                        EQU        1                    ; Truncation performed    - obsolete 
  79. smTruncErr                        EQU        -1                    ; General error - obsolete 
  80. ; typedef SInt8                         StyledLineBreakCode
  81.  
  82.  
  83. smBreakWord                        EQU        0
  84. smBreakChar                        EQU        1
  85. smBreakOverflow                    EQU        2
  86. ScriptRunStatus            RECORD 0
  87. script                     ds.b    1                ; offset: $0 (0)
  88. runVariant                 ds.b    1                ; offset: $1 (1)
  89. sizeof                     EQU *                    ; size:   $2 (2)
  90.                         ENDR
  91. BreakTable                RECORD 0
  92. charTypes                 ds.b    256                ; offset: $0 (0)
  93. tripleLength             ds.w    1                ; offset: $100 (256)
  94. triples                     ds.w    1                ; offset: $102 (258) <-- really an array of length one
  95. sizeof                     EQU *                    ; size:   $104 (260)
  96.                         ENDR
  97. ; typedef struct BreakTable *            BreakTablePtr
  98.  
  99. NBreakTable                RECORD 0
  100. flags1                     ds.b    1                ; offset: $0 (0)
  101. flags2                     ds.b    1                ; offset: $1 (1)
  102. version                     ds.w    1                ; offset: $2 (2)
  103. classTableOff             ds.w    1                ; offset: $4 (4)
  104. auxCTableOff             ds.w    1                ; offset: $6 (6)
  105. backwdTableOff             ds.w    1                ; offset: $8 (8)
  106. forwdTableOff             ds.w    1                ; offset: $A (10)
  107. doBackup                 ds.w    1                ; offset: $C (12)
  108. length                     ds.w    1                ; offset: $E (14)        ;  length of NBreakTable 
  109. charTypes                 ds.b    256                ; offset: $10 (16)
  110. tables                     ds.w    1                ; offset: $110 (272) <-- really an array of length one
  111. sizeof                     EQU *                    ; size:   $112 (274)
  112.                         ENDR
  113. ; typedef struct NBreakTable *            NBreakTablePtr
  114.  
  115. ;  The following functions are new names that work on 68k and PowerPC
  116. ;
  117. ; pascal long Munger(Handle h, long offset, const void *ptr1, long len1, const void *ptr2, long len2)
  118. ;
  119.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  120.         _Munger:    OPWORD    $A9E0
  121.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  122.         IMPORT_CFM_FUNCTION Munger
  123.     ENDIF
  124.  
  125. ;
  126. ; pascal StringHandle NewString(ConstStr255Param theString)
  127. ;
  128.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  129.         _NewString:    OPWORD    $A906
  130.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  131.         IMPORT_CFM_FUNCTION NewString
  132.     ENDIF
  133.  
  134. ;
  135. ; pascal void SetString(StringHandle theString, ConstStr255Param strNew)
  136. ;
  137.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  138.         _SetString:    OPWORD    $A907
  139.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  140.         IMPORT_CFM_FUNCTION SetString
  141.     ENDIF
  142.  
  143. ;
  144. ; pascal StringHandle GetString(short stringID)
  145. ;
  146.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  147.         _GetString:    OPWORD    $A9BA
  148.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  149.         IMPORT_CFM_FUNCTION GetString
  150.     ENDIF
  151.  
  152. ;
  153. ; pascal StyledLineBreakCode StyledLineBreak(Ptr textPtr, long textLen, long textStart, long textEnd, long flags, Fixed *textWidth, long *textOffset)
  154. ;
  155.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  156.         Macro
  157.         _StyledLineBreak
  158.             move.l              #$821CFFFE,-(sp)
  159.             dc.w                $A8B5
  160.         EndM
  161.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  162.         IMPORT_CFM_FUNCTION StyledLineBreak
  163.     ENDIF
  164.  
  165. ;
  166. ; pascal short TruncString(short width, Str255 theString, TruncCode truncWhere)
  167. ;
  168.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  169.         Macro
  170.         _TruncString
  171.             move.l              #$8208FFE0,-(sp)
  172.             dc.w                $A8B5
  173.         EndM
  174.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  175.         IMPORT_CFM_FUNCTION TruncString
  176.     ENDIF
  177.  
  178. ;
  179. ; pascal short TruncText(short width, Ptr textPtr, short *length, TruncCode truncWhere)
  180. ;
  181.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  182.         Macro
  183.         _TruncText
  184.             move.l              #$820CFFDE,-(sp)
  185.             dc.w                $A8B5
  186.         EndM
  187.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  188.         IMPORT_CFM_FUNCTION TruncText
  189.     ENDIF
  190.  
  191. ;
  192. ; pascal void FindWordBreaks(Ptr textPtr, short textLength, short offset, Boolean leadingEdge, BreakTablePtr breaks, OffsetTable offsets, ScriptCode script)
  193. ;
  194.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  195.         Macro
  196.         _FindWordBreaks
  197.             move.l              #$C012001A,-(sp)
  198.             dc.w                $A8B5
  199.         EndM
  200.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  201.         IMPORT_CFM_FUNCTION FindWordBreaks
  202.     ENDIF
  203.  
  204. ;
  205. ; pascal void LowercaseText(Ptr textPtr, short len, ScriptCode script)
  206. ;
  207.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  208.         Macro
  209.         _LowercaseText
  210.             move.w              #$0000,-(sp)
  211.             move.l              #$800AFFB6,-(sp)
  212.             dc.w                $A8B5
  213.         EndM
  214.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  215.         IMPORT_CFM_FUNCTION LowercaseText
  216.     ENDIF
  217.  
  218. ;
  219. ; pascal void UppercaseText(Ptr textPtr, short len, ScriptCode script)
  220. ;
  221.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  222.         Macro
  223.         _UppercaseText
  224.             move.w              #$0400,-(sp)
  225.             move.l              #$800AFFB6,-(sp)
  226.             dc.w                $A8B5
  227.         EndM
  228.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  229.         IMPORT_CFM_FUNCTION UppercaseText
  230.     ENDIF
  231.  
  232. ;
  233. ; pascal void StripDiacritics(Ptr textPtr, short len, ScriptCode script)
  234. ;
  235.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  236.         Macro
  237.         _StripDiacritics
  238.             move.w              #$0200,-(sp)
  239.             move.l              #$800AFFB6,-(sp)
  240.             dc.w                $A8B5
  241.         EndM
  242.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  243.         IMPORT_CFM_FUNCTION StripDiacritics
  244.     ENDIF
  245.  
  246. ;
  247. ; pascal void UppercaseStripDiacritics(Ptr textPtr, short len, ScriptCode script)
  248. ;
  249.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  250.         Macro
  251.         _UppercaseStripDiacritics
  252.             move.w              #$0600,-(sp)
  253.             move.l              #$800AFFB6,-(sp)
  254.             dc.w                $A8B5
  255.         EndM
  256.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  257.         IMPORT_CFM_FUNCTION UppercaseStripDiacritics
  258.     ENDIF
  259.  
  260. ;
  261. ; pascal ScriptRunStatus FindScriptRun(Ptr textPtr, long textLen, long *lenUsed)
  262. ;
  263.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  264.         Macro
  265.         _FindScriptRun
  266.             move.l              #$820C0026,-(sp)
  267.             dc.w                $A8B5
  268.         EndM
  269.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  270.         IMPORT_CFM_FUNCTION FindScriptRun
  271.     ENDIF
  272.  
  273.  
  274. ;      The following functions are old names, but are required for PowerPC builds
  275. ;      because InterfaceLib exports these names, instead of the new ones.
  276.  
  277.  
  278.  
  279. ;
  280. ; pascal void FindWord(Ptr textPtr, short textLength, short offset, Boolean leadingEdge, BreakTablePtr breaks, OffsetTable offsets)
  281. ;
  282.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  283.         Macro
  284.         _FindWord
  285.             move.l              #$8012001A,-(sp)
  286.             dc.w                $A8B5
  287.         EndM
  288.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  289.         IMPORT_CFM_FUNCTION FindWord
  290.     ENDIF
  291.  
  292. ;
  293. ; pascal void NFindWord(Ptr textPtr, short textLength, short offset, Boolean leadingEdge, NBreakTablePtr nbreaks, OffsetTable offsets)
  294. ;
  295.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  296.         Macro
  297.         _NFindWord
  298.             move.l              #$8012FFE2,-(sp)
  299.             dc.w                $A8B5
  300.         EndM
  301.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  302.         IMPORT_CFM_FUNCTION NFindWord
  303.     ENDIF
  304.  
  305.  
  306. ;   On 68K machines, LwrText, LowerText, StripText, UpperText and StripUpperText
  307. ;   return an error code in register D0, but System 7 PowerMacs do not emulate
  308. ;   this properly, so checking D0 is unreliable.
  309.  
  310.  
  311.  
  312. ;
  313. ; pascal void LwrText(Ptr textPtr, short len)
  314. ;
  315.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  316.         ; parameters:
  317.         ;    textPtr         => A0
  318.         ;    len             => D0
  319.         _LwrText:    OPWORD    $A056
  320.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  321.         IMPORT_CFM_FUNCTION LwrText
  322.     ENDIF
  323.  
  324. ;
  325. ; pascal void LowerText(Ptr textPtr, short len)
  326. ;
  327.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  328.         ; parameters:
  329.         ;    textPtr         => A0
  330.         ;    len             => D0
  331.         _LowerText:    OPWORD    $A056
  332.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  333.         IMPORT_CFM_FUNCTION LowerText
  334.     ENDIF
  335.  
  336. ;
  337. ; pascal void StripText(Ptr textPtr, short len)
  338. ;
  339.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  340.         ; parameters:
  341.         ;    textPtr         => A0
  342.         ;    len             => D0
  343.         _StripText:    OPWORD    $A256
  344.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  345.         IMPORT_CFM_FUNCTION StripText
  346.     ENDIF
  347.  
  348. ;
  349. ; pascal void UpperText(Ptr textPtr, short len)
  350. ;
  351.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  352.         ; parameters:
  353.         ;    textPtr         => A0
  354.         ;    len             => D0
  355.         _UpperText:    OPWORD    $A456
  356.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  357.         IMPORT_CFM_FUNCTION UpperText
  358.     ENDIF
  359.  
  360. ;
  361. ; pascal void StripUpperText(Ptr textPtr, short len)
  362. ;
  363.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  364.         ; parameters:
  365.         ;    textPtr         => A0
  366.         ;    len             => D0
  367.         _StripUpperText:    OPWORD    $A656
  368.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  369.         IMPORT_CFM_FUNCTION StripUpperText
  370.     ENDIF
  371.  
  372.  
  373. ;  The following are new names which are exported by InterfaceLib
  374.  
  375.     IF TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  376. ;
  377. ; extern void UpperString(BytePtr textPtr, UInt16 length)
  378. ;
  379.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  380.         ; parameters:
  381.         ;    textPtr         => A0
  382.         ;    length          => D0
  383.         _UpperString:    OPWORD    $A054
  384.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  385.         IMPORT_CFM_FUNCTION UpperString
  386.     ENDIF
  387.  
  388. ;
  389. ; extern void UpperStringMarks(BytePtr textPtr, UInt16 length)
  390. ;
  391.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  392.         ; parameters:
  393.         ;    textPtr         => A0
  394.         ;    length          => D0
  395.         _UpperStringMarks:    OPWORD    $A254
  396.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  397.         IMPORT_CFM_FUNCTION UpperStringMarks
  398.     ENDIF
  399.  
  400.     ELSE
  401. ;
  402. ; pascal void UpperString(Str255 theString, Boolean diacSensitive)
  403. ;
  404.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  405.         IMPORT_CFM_FUNCTION UpperString
  406.     ENDIF
  407.  
  408.     ENDIF
  409. ;  Old routine name but no new names are mapped to it:
  410. ;
  411. ; pascal void UprText(Ptr textPtr, short len)
  412. ;
  413.     IF TARGET_OS_MAC ** TARGET_CPU_68K ** ¬ TARGET_RT_MAC_CFM THEN
  414.         ; parameters:
  415.         ;    textPtr         => A0
  416.         ;    len             => D0
  417.         _UprText:    OPWORD    $A054
  418.     ELSEIF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  419.         IMPORT_CFM_FUNCTION UprText
  420.     ENDIF
  421.  
  422. ; 
  423. ;
  424. ;    Functions for converting between C and Pascal Strings
  425. ;    (Previously in Strings.h)
  426. ;    
  427. ;
  428.  
  429.     ENDIF ; __TEXTUTILS__ 
  430.  
  431.